home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / c / ppl4c.exe / PPL4C.USR < prev    next >
Text File  |  1992-10-17  |  52KB  |  1,368 lines
  1.  
  2.  
  3.                           Personal Protocol Library
  4.  
  5.                                 For the C Language
  6.  
  7.  
  8.                                     (PPL4C)
  9.  
  10.  
  11.  
  12.                                  USERS MANUAL
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                                   Version 1.0
  19.  
  20.                                   Aug 16, 1992
  21.  
  22.  
  23.  
  24.  
  25.                         This software is provided as-is.
  26.                  There are no warranties, expressed or implied.
  27.  
  28.  
  29.  
  30.  
  31.                               Copyright (C) 1992
  32.                               All rights reserved
  33.  
  34.  
  35.  
  36.                               MarshallSoft Computing, Inc.
  37.                               Post Office Box 4543
  38.                               Huntsville AL 35815
  39.  
  40.                               Phone (205) 881-4630
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.         PPL4C Users Manual                                     Page 1
  61.                               C O N T E N T S
  62.  
  63.  
  64.  
  65.  
  66.  
  67.          Chapter                                                   Page
  68.  
  69.          1.0 Introduction..............................................3
  70.              1.1 Compiling the Library.................................3
  71.              1.2 User Support..........................................4
  72.              1.3 Installation..........................................5
  73.          2.0 State Drivers.............................................6
  74.          3.0 File Transfer Protocols...................................7
  75.              3.1 XMODEM................................................7
  76.              3.2 XMODEM-CRC............................................9
  77.              3.3 XMODEM-1K.............................................9
  78.              3.4 XMODEM-G.............................................10
  79.              3.5 YMODEM...............................................10
  80.              3.6 YMODEM-G.............................................10
  81.          4.0 Protocol Library Functions...............................11
  82.              4.1 xyAbort..............................................11
  83.              4.2 xyDriver.............................................11
  84.              4.3 xyGetErrorCode.......................................12
  85.              4.4 xyGetErrorState......................................12
  86.              4.5 xyGetFilename........................................12
  87.              4.6 xyGetNAKs............................................12
  88.              4.7 xyGetPacket..........................................12
  89.              4.8 xyGetState...........................................12
  90.              4.9 xyInit...............................................13
  91.              4.10 xyStartRx...........................................13
  92.              4.11 xyStartTx...........................................13
  93.          5.0 The FILEXFER.C Demonstration Program.....................14
  94.              5.1 Introduction.........................................14
  95.              5.2 The FILEXFER.H Parameter File........................15
  96.              5.3 Running FILEXFER.....................................16
  97.          6.0 Using The Protocol Library...............................17
  98.              6.1 Keyboard Input.......................................17
  99.              6.2 Disk I/O.............................................18
  100.              6.3 Serial I/O...........................................18
  101.              6.4 Other Events.........................................18
  102.          7.0 Problems.................................................19
  103.          8.0 Legal Issues.............................................20
  104.              8.1 Registration.........................................21
  105.              8.2 License..............................................21
  106.              8.3 Warranty.............................................21
  107.          9.0 Revision History.........................................21
  108.         10.0 Other MarshallSoft Computing Products....................22
  109.              10.1 The Personal Communications Library for C...........22
  110.              10.2 The LZW Data Compression Library for C..............22
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.         PPL4C Users Manual                                     Page 2
  121.          1.0 Introduction
  122.  
  123.          The Personal Protocol Library (PPL)  consist  of  a  state  driven
  124.          library   which  implements  the  XMODEM,  XMODEM-CRC,  XMODEM-1K,
  125.          XMODEM-G, YMODEM,  and  YMODEM-G  file  transfer  protocols.  This
  126.          allows   the   programmer   to  run  multiple  protocol  transfers
  127.          simultaneously while interacting with the user at the keyboard.
  128.  
  129.          The  PPL  requires  the  Personal  Protocol  Library  (PCL),  also
  130.          available   from  MarshallSoft  Computing.   The  user  should  be
  131.          familiar with PCL before  attempting  to  understand  the  protocol
  132.          driver. Refer to section "Other MarshallSoft Computing Products".
  133.  
  134.          What  are  the advantages of a state driven protocol library ? The
  135.          answer is  any  type  of  communications  program  which  requires
  136.          "background" protocol file transfers. A few examples are:
  137.  
  138.          (1)  EXAMPLE-1: A program that can read incoming stock market data
  139.          continuously  while  the  main  application  is  doing   technical
  140.          analysis.
  141.  
  142.          (2)  EXAMPLE-2:  A  custom  BBS  program  that can handle two file
  143.          transfers simultaneously.
  144.  
  145.          See the section 8.1 "Registration" for an offer who might not want
  146.          to refuse!
  147.  
  148.          1.1 Compiling the Library
  149.  
  150.          There are three small model library files provided:
  151.  
  152.          ppl4c_sb.lib  -- Borland Turbo C library.
  153.          ppl4c_sm.lib  -- Microsoft C library.
  154.          ppl4c_sx.mix  -- MIX Power C library.
  155.  
  156.          The  registered user can recompile the source code (source code is
  157.          provided in the registered version only) for the library using one
  158.          of the three provided batch files:
  159.  
  160.          make_sb.bat  -- make small Borland Turbo C library (ppl4c_sb.lib).
  161.          make_sm.bat  -- make small Micrsoft C library (ppl4c_sm.lib).
  162.          make_sx.bat  -- make small MIX Power C library (ppl4c_sx.mix).
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.         PPL4C Users Manual                                     Page 3
  181.          1.2 User Support
  182.  
  183.          We want you to be successful in developing your applications using
  184.          PPL4C!  We depend on our customers to let us know what  they  need
  185.          in  a  protocol library.  This means we are committed to providing
  186.          the best communications library that  we  can.  If  you  have  any
  187.          suggestions or comments, please write to us or give us a call.
  188.  
  189.          If  you  are  having  a  problem  using PPL4C, call (205) 881-4630
  190.          between 5 PM and 9 PM CST Monday through Saturday. You can call at
  191.          other times and leave a message, and call back  later  during  our
  192.          regular  business  hours  for a reply. You can also FAX us at this
  193.          same number at any time.
  194.  
  195.          You  may  also  call our 24 hour BBS (2400 baud, no parity, 8 data
  196.          bits, 1 stop bit) at any time.  The BBS will  contain  the  latest
  197.          shareware version of PPL4C, messages, and other related files. All
  198.          files  are  in standard ZIP format. You can leave a message on the
  199.          BBS, and we will usually have a reply  ready  for  you  within  24
  200.          hours.   The  dedicated telephone number is 205-880-9748. Set your
  201.          modem for 2400 baud, 8 data bits, no parity, one stop bit.
  202.  
  203.          The  MarshallSoft  Computing,  Inc.   newsletter  "Comm  Talk"  is
  204.          published quarterly.  It discusses various communications problems
  205.          and solutions using PCL4C (the communications library)  and  PPL4C
  206.          (the  protocol library) as well as related information. Registered
  207.          users receive a one year  complimentary  subscription  when  first
  208.          registering and for each update purchased.
  209.  
  210.          Of  course, you can always write to us. You should receive a reply
  211.          within one to two weeks.
  212.  
  213.  
  214.  
  215.  
  216.  
  217.